# SOME DESCRIPTIVE TITLE
# Copyright (C) YEAR The FreeBSD Project
# This file is distributed under the same license as the FreeBSD Documentation package.
# FIRST AUTHOR <EMAIL@ADDRESS>, YEAR.
#
#, fuzzy
msgid ""
msgstr ""
"Project-Id-Version: FreeBSD Documentation VERSION\n"
"POT-Creation-Date: 2023-04-20 20:56-0300\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: FULL NAME <EMAIL@ADDRESS>\n"
"Language-Team: LANGUAGE <LL@li.org>\n"
"Language: \n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"

#. type: YAML Front Matter: description
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:1
#, no-wrap
msgid "Overview about the FreeBSD Documentation Process"
msgstr ""

#. type: YAML Front Matter: title
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:1
#, no-wrap
msgid "Chapter 1. Overview"
msgstr ""

#. type: Title =
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:13
#, no-wrap
msgid "Overview"
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:52
msgid ""
"Welcome to the FreeBSD Documentation Project (FDP).  Quality documentation "
"is crucial to the success of FreeBSD, and we value your contributions very "
"highly."
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:54
msgid ""
"This document describes how the FDP is organized, how to write and submit "
"documentation, and how to effectively use the available tools."
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:57
msgid ""
"Everyone is welcome to contribute to the FDP.  Willingness to contribute is "
"the only membership requirement."
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:59
msgid "This primer shows how to:"
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:61
msgid "Understand the role of documentation and its place in the ecosystem."
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:62
msgid "Identify which parts of FreeBSD are maintained by the FDP."
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:63
msgid "Install the required documentation tools and files."
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:64
msgid "Make changes to the documentation."
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:65
msgid ""
"Submit changes back for review and inclusion in the FreeBSD documentation."
msgstr ""

#. type: Title ==
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:67
#, no-wrap
msgid "Documentation in the FreeBSD Ecosystem"
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:71
msgid ""
"All documents are for the benefit of their readers, not their writers or "
"caretakers.  They should adapt to the reader and not expect the reader to "
"adapt to them."
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:73
msgid "Never blame the reader for:"
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:75
msgid "being unable to make use of a document easily or at all"
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:76
msgid "finding a document confusing"
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:77
msgid "not understanding a document or how to apply it"
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:78
msgid ""
"not finding an explicit answer or successfully bridging gaps (or connecting "
"dots) to reason their way to one"
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:80
msgid "Instead, acknowledge that the document is:"
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:82
msgid "inaccessible"
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:83
msgid "confusing"
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:84
msgid "hard to understand or apply"
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:85
msgid "incomplete"
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:87
msgid "Then, make the document:"
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:89
msgid "more accessible"
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:90
msgid "less confusing"
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:91
msgid "clearer"
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:92
msgid "more complete"
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:94
msgid "Use the following methods:"
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:96
msgid ""
"apply link:https://webaim.org/intro/#principles[accessibility best "
"practices] to correct the problem reported and any similar ones you find"
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:97
msgid "rework or clarify the confusing structure or language"
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:98
msgid "add relevant examples to the part that is hard to understand or apply"
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:99
msgid "fill in the gaps or add the missing stepping stones"
msgstr ""

#. type: Title ==
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:101
#, no-wrap
msgid "Quick Start"
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:107
msgid ""
"Some preparatory steps must be taken before editing the FreeBSD "
"documentation.  First, subscribe to the {freebsd-doc}.  Some team members "
"also interact on the `#bsddocs` IRC channel on http://www.efnet.org/"
"[EFnet].  These people can help with questions or problems involving the "
"documentation."
msgstr ""

#. type: Title ===
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:109
#, no-wrap
msgid "FreeBSD installation process"
msgstr ""

#. type: delimited block = 4
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:114
msgid ""
"Install these packages. The `docproj` _meta-port_ installs all the "
"applications required to do useful work with the FreeBSD documentation."
msgstr ""

#. type: delimited block . 4
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:118
#, no-wrap
msgid "# pkg install docproj\n"
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:121
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:200
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:285
msgid ""
"Install a local working copy of the documentation from the FreeBSD "
"repository in [.filename]#~/doc# (see crossref:working-copy[working-copy,The "
"Working Copy])."
msgstr ""

#. type: delimited block . 4
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:125
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:204
#, no-wrap
msgid "% git clone https://git.FreeBSD.org/doc.git ~/doc\n"
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:128
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:207
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:292
msgid ""
"Edit the documentation files that require changes. If a file needs major "
"changes, consult the mailing list for input."
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:131
msgid ""
"Review the output and edit the file to fix any problems shown, then rerun "
"the command to find any remaining problems.  Repeat until all of the errors "
"are resolved."
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:133
#, no-wrap
msgid "*_Always_* build and review the changes before submitting them. Running `make` in the `documentation` or `website` subdirectories will generate the documentation in HTML format.\n"
msgstr ""

#. type: delimited block . 4
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:137
#, no-wrap
msgid "% make\n"
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:140
msgid "To reduce compile time, only one language can be compiled:"
msgstr ""

#. type: delimited block . 4
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:144
#, no-wrap
msgid "% make DOC_LANG=en\n"
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:147
msgid ""
"The build output is stored in [.filename]#~/documentation/public/articles/# "
"and [.filename]#~/documentation/public/books/#."
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:149
msgid ""
"Review the build output and ensure the edits are free from typos, layout "
"problems, or errors. If any errors are found during the build process, edit "
"the problematic files to fix any issues that show up, then run the build "
"command again until all errors are resolved."
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:151
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:219
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:303
msgid ""
"Add all the files with `git add .`, then review the diff with `git diff`. "
"For example:"
msgstr ""

#. type: delimited block . 4
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:156
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:224
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:308
#, no-wrap
msgid ""
"% git add .\n"
"% git diff --staged\n"
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:159
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:227
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:311
msgid ""
"Make sure that all required files are included, then commit the change to "
"your local branch and generate a patch with `git format-patch`"
msgstr ""

#. type: delimited block . 4
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:164
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:232
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:316
#, no-wrap
msgid ""
"% git commit\n"
"% git format-patch origin/main\n"
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:168
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:236
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:320
msgid ""
"Patch generated with `git format-patch` will include author identity and "
"email addresses, making it easier for developers to apply (with `git am`) "
"and give proper credit."
msgstr ""

#. type: delimited block = 6
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:173
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:241
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:325
msgid ""
"To make it easier for committers to apply the patch on their working copy of "
"the documentation tree, please generate the [.filename]#.diff# from the base "
"of your documentation tree."
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:176
msgid ""
"In the example above, changes have been made to the *bsdinstall* portion of "
"the Handbook."
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:178
msgid ""
"Submit the patch or diff file using the web-based https://bugs.FreeBSD.org/"
"bugzilla/enter_bug.cgi?product=Documentation[Problem Report] system. If "
"using the web form, enter a Summary of _[patch] short description of "
"problem_. Select the Component `Documentation`. In the Description field, "
"enter a short description of the changes and any important details about "
"them. Use the btn:[Add an attachment] button to attach the patch or diff "
"file. Finally, use the btn:[Submit Bug] button to submit your diff to the "
"problem report system."
msgstr ""

#. type: Title ===
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:181
#, no-wrap
msgid "GNU/Linux installation process"
msgstr ""

#. type: delimited block = 6
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:188
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:259
msgid "Hugo version 0.90 or higher must be used"
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:193
msgid ""
"Install these packages in apt-based systems like Debian or Ubuntu.  On other "
"GNU/Linux distributions the package names may change.  Consult your "
"distribution's package manager if in doubt."
msgstr ""

#. type: delimited block . 4
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:197
#, no-wrap
msgid "# apt install hugo ruby-asciidoctor ruby-asciidoctor-pdf ruby-rouge git bmake\n"
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:210
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:295
msgid ""
"Review the output and edit the files to fix any problems shown, then rerun "
"the command to find any remaining problems.  Repeat until all of the errors "
"are resolved."
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:212
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:297
msgid ""
"Always build and test the changes before submitting them. Running `bmake` in "
"the `documentation` or `website` subdirectories will generate the "
"documentation in HTML format."
msgstr ""

#. type: delimited block . 4
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:216
#, no-wrap
msgid "% bmake run LOCALBASE=/usr\n"
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:249
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:333
msgid ""
"Submit the patch or diff file using the web-based https://bugs.FreeBSD.org/"
"bugzilla/enter_bug.cgi?product=Documentation[Problem Report] system.  If "
"using the web form, enter a Summary of _short description of problem_.  "
"Select the Component `Documentation`.  In the Description field, enter a "
"short description of the problem in the _Summary_ field and add _patch_ to "
"the _Keywords_ field.  Use the btn:[Add an attachment] button to attach the "
"patch or diff file.  Finally, use the btn:[Submit Bug] button to submit your "
"diff to the problem report system."
msgstr ""

#. type: Title ===
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:252
#, no-wrap
msgid "macOS(R) installation process"
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:262
msgid ""
"Install these packages using link:https://brew.sh/[Homebrew] and link:"
"https://rubygems.org/[RubyGem]."
msgstr ""

#. type: delimited block . 4
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:266
#, no-wrap
msgid "$ brew install hugo ruby git bmake\n"
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:269
msgid "Add Ruby to the Path."
msgstr ""

#. type: delimited block . 4
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:275
#, no-wrap
msgid ""
"$ echo 'export GEM_PATH=\"$(gem environment gemdir)\"' >> ~/.zshrc\n"
"$ echo 'export PATH=\"$(brew --prefix ruby)/bin:$PATH\"' >> ~/.zshrc\n"
"$ source ~/.zshrc\n"
msgstr ""

#. type: Plain text
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:278
msgid "Install the rouge package using RubyGem."
msgstr ""

#. type: delimited block . 4
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:282
#, no-wrap
msgid "$ sudo gem install rouge asciidoctor asciidoctor-pdf asciidoctor-epub3\n"
msgstr ""

#. type: delimited block . 4
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:289
#, no-wrap
msgid "$ git clone https://git.FreeBSD.org/doc.git ~/doc\n"
msgstr ""

#. type: delimited block . 4
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:301
#, no-wrap
msgid "$ bmake run LOCALBASE=/opt/homebrew USE_RUBYGEMS=YES\n"
msgstr ""

#. type: Title ==
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:336
#, no-wrap
msgid "The FreeBSD Documentation Set"
msgstr ""

#. type: delimited block = 4
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:339
msgid "The FDP is responsible for four categories of FreeBSD documentation."
msgstr ""

#. type: delimited block = 4
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:341
msgid ""
"_Handbook_: The Handbook is the comprehensive online resource and reference "
"for FreeBSD users."
msgstr ""

#. type: delimited block = 4
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:342
msgid ""
"_FAQ_: The FAQ uses a short question and answer format to address questions "
"that are frequently asked on the various mailing lists and forums devoted to "
"FreeBSD. This format does not permit long and comprehensive answers."
msgstr ""

#. type: delimited block = 4
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:343
msgid ""
"_Manual pages_: The English language system manual pages are usually not "
"written by the FDP, as they are part of the base system. However, the FDP "
"can reword parts of existing manual pages to make them clearer or to correct "
"inaccuracies."
msgstr ""

#. type: delimited block = 4
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:344
msgid ""
"_Web site_: This is the main FreeBSD presence on the web, visible at https://"
"www.freebsd.org/[https://www.FreeBSD.org/] and many mirrors around the "
"world. The web site is typically a new user's first exposure to FreeBSD."
msgstr ""

#. type: delimited block = 4
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:347
msgid ""
"Translation teams are responsible for translating the Handbook and web site "
"into different languages.  Manual pages are not translated at present."
msgstr ""

#. type: delimited block = 4
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:349
msgid ""
"Documentation source for the FreeBSD web site, Handbook, and FAQ is "
"available in the documentation repository at `https://cgit.freebsd.org/doc/`."
msgstr ""

#. type: delimited block = 4
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:351
msgid ""
"Source for manual pages is available in a separate source repository located "
"at `https://cgit.freebsd.org/src/`."
msgstr ""

#. type: delimited block = 4
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:354
msgid ""
"Documentation commit messages are visible with `git log`.  Commit messages "
"are also archived at link:{dev-commits-doc-all}."
msgstr ""

#. type: delimited block = 4
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:356
msgid ""
"Web frontends to both of these repositories are available at https://cgit."
"freebsd.org/doc/[] and https://cgit.freebsd.org/src/[]."
msgstr ""

#. type: delimited block = 4
#: documentation/content/en/books/fdp-primer/overview/_index.adoc:360
msgid ""
"Many people have written tutorials or how-to articles about FreeBSD.  Some "
"are stored as part of the FDP files.  In other cases, the author has decided "
"to keep the documentation separate.  The FDP endeavors to provide links to "
"as much of this external documentation as possible."
msgstr ""
